Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(rfq-relayer): skip cache when fetching committable balances [SLT-386] #3328

Merged
merged 4 commits into from
Oct 29, 2024

Conversation

dwasse
Copy link
Collaborator

@dwasse dwasse commented Oct 23, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced gas balance retrieval process for improved performance and data accuracy.
    • Updated methods for handling inventory checks to ensure better management of balance and inventory status.
  • Bug Fixes

    • Maintained consistent error handling for unsupported chains and insufficient inventory scenarios.

Copy link
Contributor

coderabbitai bot commented Oct 23, 2024

Walkthrough

The pull request modifies the HasSufficientGas method in the inventoryManagerImpl struct and updates the commitPendingBalance and handleNotEnoughInventory methods in the QuoteRequestHandler class. The key change is the addition of the SkipDBCache() argument to the GetCommittableBalance method calls, which alters how gas and committable balances are retrieved, bypassing the database cache. The overall control flow and error handling remain unchanged, and various comments and TODOs have been added for future improvements.

Changes

File Path Change Summary
services/rfq/relayer/inventory/manager.go Updated HasSufficientGas method to include SkipDBCache() in GetCommittableBalance call.
services/rfq/relayer/service/handlers.go Modified commitPendingBalance and handleNotEnoughInventory methods to include SkipDBCache() in GetCommittableBalance calls.

Possibly related PRs

  • add inflight quote cache #2963: The changes in this PR involve modifications to the inventoryManagerImpl struct in manager.go, specifically the introduction of the inFlightQuoteManager, which is relevant to the changes made to the HasSufficientGas method that also involve balance retrieval logic.

Suggested labels

go, needs-go-generate-services/rfq, size/m

Suggested reviewers

  • trajan0x
  • aureliusbtc

🐇 In the fields where bunnies roam,
We skip the cache, we call it home.
With gas and balance, all in line,
Our code now dances, oh so fine!
So hop along, let changes flow,
In the land of code, we make it glow! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added go Pull requests that update Go code size/xs labels Oct 23, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
services/rfq/relayer/service/handlers.go (1)

220-220: Consider monitoring performance impact.

While skipping the DB cache ensures data accuracy, it may impact performance due to increased direct balance checks. Consider monitoring response times and adding metrics to track any performance changes.

Also applies to: 629-629

services/rfq/relayer/inventory/manager.go (1)

458-458: LGTM! Consider monitoring performance impact.

The addition of SkipDBCache() ensures real-time gas balance accuracy, which is crucial for preventing failed transactions. However, bypassing the cache might impact performance under high load.

Consider:

  1. Monitoring response times to detect any performance degradation
  2. Implementing a shorter cache TTL instead of completely skipping the cache if performance becomes a concern
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ae93258 and b118ff9.

📒 Files selected for processing (2)
  • services/rfq/relayer/inventory/manager.go (1 hunks)
  • services/rfq/relayer/service/handlers.go (2 hunks)
🧰 Additional context used
🔇 Additional comments (2)
services/rfq/relayer/service/handlers.go (2)

220-220: LGTM! Skipping DB cache in commitPendingBalance.

The addition of inventory.SkipDBCache() ensures fresh balance data when committing pending balances, which is crucial for accurate balance management.


629-629: LGTM! Skipping DB cache in handleNotEnoughInventory.

The addition of inventory.SkipDBCache() ensures accurate balance checks during retry attempts, which is essential for proper inventory management.

Copy link

codecov bot commented Oct 23, 2024

Codecov Report

Attention: Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 33.22599%. Comparing base (42c0079) to head (857d137).
Report is 13 commits behind head on master.

Files with missing lines Patch % Lines
services/rfq/relayer/service/handlers.go 0.00000% 2 Missing ⚠️
Additional details and impacted files
@@                 Coverage Diff                 @@
##              master       #3328         +/-   ##
===================================================
- Coverage   33.25951%   33.22599%   -0.03352%     
===================================================
  Files            543         543                 
  Lines          34769       34780         +11     
  Branches          82          82                 
===================================================
- Hits           11564       11556          -8     
- Misses         22182       22201         +19     
  Partials        1023        1023                 
Flag Coverage Δ
opbot 0.48870% <ø> (ø)
packages 90.44834% <ø> (ø)
promexporter 6.81642% <ø> (ø)
rfq 24.54476% <33.33333%> (-0.11682%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

cloudflare-workers-and-pages bot commented Oct 23, 2024

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 857d137
Status: ✅  Deploy successful!
Preview URL: https://4b1f7807.sanguine-fe.pages.dev
Branch Preview URL: https://fix-skip-cache.sanguine-fe.pages.dev

View logs

Copy link
Collaborator

@ChiTimesChi ChiTimesChi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this should resolve the "same time commit balance" problem, but worth noting that all GetCommittableBalance calls are now done with SkipDBCache option, so might want to enforce it there instead.

Relay time impact remains to be seen at staging, but shouldn't be massive?

@trajan0x trajan0x changed the title fix(rfq-relayer): skip cache when fetching committable balances fix(rfq-relayer): skip cache when fetching committable balances [SLT-386] Oct 24, 2024
@trajan0x trajan0x merged commit 126e683 into master Oct 29, 2024
54 checks passed
@trajan0x trajan0x deleted the fix/skip-cache branch October 29, 2024 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
go Pull requests that update Go code needs-go-generate-services/rfq size/xs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants